/*
 * Copyright (C) 2021 Huawei Device Co., Ltd.
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package io.sentry.util;

import io.sentry.hints.ApplyScopeData;
import io.sentry.hints.Cached;

import org.jetbrains.annotations.ApiStatus;
import org.jetbrains.annotations.Nullable;

/**
 * Util class for Applying or not scope's data to an event
 *
 * @since 2021-06-02
 */
@ApiStatus.Internal
public final class ApplyScopeUtils {
    private ApplyScopeUtils() {
    }

    /**
     * Scope's data should be applied if: Hint is of the type ApplyScopeData or Hint is not Cached
     * (this includes a null hint)
     *
     * @param hint the hint
     * @return true if it should apply scope's data or false otherwise
     */
    public static boolean shouldApplyScopeData(final @Nullable Object hint) {
        return !(hint instanceof Cached) || (hint instanceof ApplyScopeData);
    }
}
